<!doctype html>
<html lang="en">
<head>
    <title>API for class elementDoc (phpAPI: PHP Documentation Creator version 6.0)</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <meta name="generator" content="phpAPI 6.0 (https://github.com/Greenray/phpAPI/)">
    <link rel="stylesheet" type="text/css" href="../style.css">
    <link rel="start" href="../index.html">
</head>
    <body id="elementDoc" onload="parent.document.title=document.title;">
    <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li><a href="../overview-summary.html">Overview</a></li>
                    <li><a href="../phpapi/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../phpapi/package-tree.html">phpapi\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="../index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
    <hr />
<div class="package">Namespace phpapi</div>
<h1>Class elementDoc</h1>
<div id="list">
    <ul>
        <li><a href="../phpapi/doc.html">doc</a><ul><li><strong>elementDoc</strong></li></ul></li>    </ul>
</div>
<hr />
<p class="arguments">public abstract  class <strong>elementDoc</strong> extends <a href="../phpapi/doc.html">doc</a></p>
<div class="comment" id="overview_description">Represents a PHP program element: global, function, class, interface, field, constructor, or method.<br /> This is an abstract class dealing with information common to these elements.</div>
<div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Program</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">phpapi: PHP Documentation Creator</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Version</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">6.0</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Author</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Victor Nabatov greenray.spb@gmail.com</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Copyright</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">(c) 2015-2016 Victor Nabatov</td>
                    </tr>
            <tr>
            <td class="hid left w_100">License</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Creative Commons Attribution-ShareAlike 4.0 International</td>
                    </tr>
            <tr>
            <td class="hid left w_100">File</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">/system/classes/elementDoc.php</td>
                    </tr>
        </table>
</div>
            <table class="inherit">
            <tr><th>Fields inherited from phpapi \ doc</th></tr>
            <tr>
                <td>
                                    <span><a href="../phpapi/doc.html#$data"><span class="green">$data, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$desc"><span class="green">$desc, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$docComment"><span class="green">$docComment, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$inBody"><span class="green">$inBody, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$name"><span class="green">$name, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$overview"><span class="green">$overview, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$root"><span class="green">$root, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$tags"><span class="green">$tags</span></a>&nbsp;</span>
                                </td>
            </tr>
        </table>
                <table class="inherit">
            <tr><th>Methods inherited from phpapi \ doc</th></tr>
            <tr>
                <td>
                                    <span><a href="../phpapi/doc.html#construct">construct, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isClass">isClass, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isConstructor">isConstructor, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isException">isException, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isField">isField, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isFunction">isFunction, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isGlobal">isGlobal, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isInterface">isInterface, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isMethod">isMethod, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isOrdinaryClass">isOrdinaryClass, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isTrait">isTrait, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#mergeData">mergeData, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#set">set, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#setByRef">setByRef</a>&nbsp;</span>
                                </td>
            </tr>
        </table>
        <h2 id="details_fields">Fields</h2>
            <div class="location">system/classes/elementDoc.php at line 19</div>
        <pre class="arguments" id="access">public  string <strong><span class="green">$access</span></strong> = <span class="red">"public"</span>;</pre>
        <div class="details">Access type for this element</div>
        <hr />
            <div class="location">system/classes/elementDoc.php at line 22</div>
        <pre class="arguments" id="filename">public  string <strong><span class="green">$filename</span></strong> = NULL;</pre>
        <div class="details">Which source file is this element in</div>
        <hr />
            <div class="location">system/classes/elementDoc.php at line 25</div>
        <pre class="arguments" id="final">public  boolean <strong><span class="green">$final</span></strong> = FALSE;</pre>
        <div class="details">If this element is final</div>
        <hr />
            <div class="location">system/classes/elementDoc.php at line 27</div>
        <pre class="arguments" id="includes">public  mixed <strong><span class="green">$includes</span></strong> = [];</pre>
        <div class="details">No description</div>
        <hr />
            <div class="location">system/classes/elementDoc.php at line 30</div>
        <pre class="arguments" id="lineNumber">public  integer <strong><span class="green">$lineNumber</span></strong> = NULL;</pre>
        <div class="details">Line in the source file this element can be found at</div>
        <hr />
            <div class="location">system/classes/elementDoc.php at line 33</div>
        <pre class="arguments" id="package">public  string <strong><span class="green">$package</span></strong> = NULL;</pre>
        <div class="details">Elements package</div>
        <hr />
            <div class="location">system/classes/elementDoc.php at line 36</div>
        <pre class="arguments" id="parameters">public  <a href="../phpapi/fielddoc.html">fieldDoc</a> <strong><span class="green">$parameters</span></strong> = [];</pre>
        <div class="details">Parameters this function takes</div>
        <hr />
            <div class="location">system/classes/elementDoc.php at line 39</div>
        <pre class="arguments" id="parent">public  <a href="../phpapi/doc.html">doc</a> <strong><span class="green">$parent</span></strong> = NULL;</pre>
        <div class="details">Reference to the parent elements</div>
        <hr />
            <div class="location">system/classes/elementDoc.php at line 42</div>
        <pre class="arguments" id="sourcePath">public  string <strong><span class="green">$sourcePath</span></strong> = NULL;</pre>
        <div class="details">Source path containing the source file</div>
        <hr />
            <div class="location">system/classes/elementDoc.php at line 45</div>
        <pre class="arguments" id="static">public  boolean <strong><span class="green">$static</span></strong> = FALSE;</pre>
        <div class="details">If this element is static</div>
        <hr />
            <div class="location">system/classes/elementDoc.php at line 48</div>
        <pre class="arguments" id="throws">public  <a href="../phpapi/classdoc.html">classDoc</a> <strong><span class="green">$throws</span></strong> = [];</pre>
        <div class="details">Exceptions this function throws</div>
        <hr />
        <h2 id="details_constructor">Constructor</h2>
    <div class="location">system/classes/elementDoc.php at line 51</div>
    <code class="arguments" id="construct">public  void <strong>construct</strong>()</code>
    <div class="details">
            <p class="description">Constructor.</p>
            </div>
    <h2 id="details_methods">Methods</h2>
            <div class="location">system/classes/elementDoc.php at line 66</div>
        <code class="arguments" id="arguments">public  string <strong>arguments</strong> ()</code>
        <div class="details">
                    <p class="description">Gets aruments of the element.<br /> Return a string whith the list of arguments with their types.<br /> <pre><br /> For a function<br />      method($x, $y, &$o), where x is mixed, y is integer and o is a reference to object<br /> it will return<br />      method(mixed $x, integer $y, object &$o)<br /> </pre><br /> Recognised types are turned into HTML anchor tags to the documentation page for the class defining them.</p>
                    </div>
        <hr />
            <div class="location">system/classes/elementDoc.php at line 83</div>
        <code class="arguments" id="path">public  string|NULL <strong>path</strong> ()</code>
        <div class="details">
                    <p class="description">Returns the element path or NULL.</p>
                    </div>
        <hr />
            <div class="location">system/classes/elementDoc.php at line 111</div>
        <code class="arguments" id="containingClass">public  classDoc|NULL <strong>containingClass</strong> ()</code>
        <div class="details">
                    <p class="description">Gets the containing class of this program element.<br /> If the element is in the global scope and does not have a parent class, this will return NULL.</p>
                    </div>
        <hr />
            <div class="location">system/classes/elementDoc.php at line 122</div>
        <code class="arguments" id="containingPackage">public  <a href="../phpapi/packagedoc.html">packageDoc</a> <strong>containingPackage</strong> ()</code>
        <div class="details">
                    <p class="description">Gets the package that this program element is contained in.</p>
                    </div>
        <hr />
            <div class="location">system/classes/elementDoc.php at line 136</div>
        <code class="arguments" id="fullNamespace">public  string <strong>fullNamespace</strong> ()</code>
        <div class="details">
                    <p class="description">Gets the fully qualified name.<br /> <pre><br /> Example:<br /> for the method bar() in class Foo in the package Baz, return:<br /> Baz\Foo\bar()<br /> </pre></p>
                    </div>
        <hr />
            <div class="location">system/classes/elementDoc.php at line 148</div>
        <code class="arguments" id="location">public  string <strong>location</strong> ()</code>
        <div class="details">
                    <p class="description">Gets the source location of this element</p>
                    </div>
        <hr />
            <div class="location">system/classes/elementDoc.php at line 163</div>
        <code class="arguments" id="modifiers">public  string <strong>modifiers</strong> ()</code>
        <div class="details">
                    <p class="description">Gets modifiers string.<br /> <pre><br /> Example, for:<br /> public abstract integer foo() { ... }<br /> modifiers() would return:<br /> 'public abstract'<br /> </pre></p>
                    </div>
        <hr />
        <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li><a href="../overview-summary.html">Overview</a></li>
                    <li><a href="../phpapi/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../phpapi/package-tree.html">phpapi\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="../index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
    </body>
</html>
